<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sar__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__sar.html">SAR          (SAR ADC Subsystem)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__sar__functions__basic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__basic.html">Initialization and Basic Functions</a></td></tr>
<tr class="memdesc:group__group__sar__functions__basic"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions is for initialization and basic usage. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__power"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__power.html">Low Power Callback</a></td></tr>
<tr class="memdesc:group__group__sar__functions__power"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions is for Deep Sleep entry and exit. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__config"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__config.html">Run-time Configuration Functions</a></td></tr>
<tr class="memdesc:group__group__sar__functions__config"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions allows changes to the SAR configuration after initialization. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__countsto"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__countsto.html">Counts Conversion Functions</a></td></tr>
<tr class="memdesc:group__group__sar__functions__countsto"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions performs counts to *volts conversions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__interrupt"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__interrupt.html">Interrupt Functions</a></td></tr>
<tr class="memdesc:group__group__sar__functions__interrupt"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions are related to SAR interrupts. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__switches"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__switches.html">SARMUX Switch Control Functions</a></td></tr>
<tr class="memdesc:group__group__sar__functions__switches"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions is for controlling/querying the SARMUX switches. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__helper"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__helper.html">Useful Configuration Query Functions</a></td></tr>
<tr class="memdesc:group__group__sar__functions__helper"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions is for useful configuration query. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__lp"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__lp.html">Low Power features control Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__fifo"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__fifo.html">FIFO buffer control Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__sar__functions__trig"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions__trig.html">Common triggering Functions for multiple SAR instances</a></td></tr>
<tr class="memdesc:group__group__sar__functions__trig"><td class="mdescLeft">&#160;</td><td class="mdescRight">This set of functions is for initialization and usage of SAR common settings and simultaneous triggering. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4da8c284be6d652454bd35c8a07d22c5"><td class="memItemLeft" align="right" valign="top"><a id="ga4da8c284be6d652454bd35c8a07d22c5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions.html#ga4da8c284be6d652454bd35c8a07d22c5">Cy_SAR_Sleep</a>&#160;&#160;&#160;<a class="el" href="group__group__sar__functions__power.html#ga7f5da233753269fdf05b5745515a7c21">Cy_SAR_DeepSleep</a></td></tr>
<tr class="memdesc:ga4da8c284be6d652454bd35c8a07d22c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro is for backward compatibility macro for driver v1.10 and before, the preferred API is <a class="el" href="group__group__sar__functions__power.html#ga7f5da233753269fdf05b5745515a7c21">Cy_SAR_DeepSleep</a>. <br /></td></tr>
<tr class="separator:ga4da8c284be6d652454bd35c8a07d22c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga939ae97436fb8ca44e6f61554d361101"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions.html#ga939ae97436fb8ca44e6f61554d361101">Cy_SAR_SimultStart</a> (PASS_Type *base, uint32_t sarMask, <a class="el" href="group__group__sar__enums.html#gaf21d08e4f15f54ac638943e50538d95c">cy_en_sar_start_convert_sel_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga939ae97436fb8ca44e6f61554d361101"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simultaneously starts two or more SARs.  <a href="#ga939ae97436fb8ca44e6f61554d361101">More...</a><br /></td></tr>
<tr class="separator:ga939ae97436fb8ca44e6f61554d361101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b1d25e53ea0afb54c136e03780f839b"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar__functions.html#ga8b1d25e53ea0afb54c136e03780f839b">Cy_SAR_SimultStop</a> (PASS_Type *base, uint32_t sarMask)</td></tr>
<tr class="memdesc:ga8b1d25e53ea0afb54c136e03780f839b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the selected SARs.  <a href="#ga8b1d25e53ea0afb54c136e03780f839b">More...</a><br /></td></tr>
<tr class="separator:ga8b1d25e53ea0afb54c136e03780f839b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga939ae97436fb8ca44e6f61554d361101"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga939ae97436fb8ca44e6f61554d361101">&#9670;&nbsp;</a></span>Cy_SAR_SimultStart()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SAR_SimultStart </td>
          <td>(</td>
          <td class="paramtype">PASS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>sarMask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sar__enums.html#gaf21d08e4f15f54ac638943e50538d95c">cy_en_sar_start_convert_sel_t</a>&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Simultaneously starts two or more SARs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>Pointer to structure describing PASS registers.</td></tr>
    <tr><td class="paramname">sarMask</td><td>specifies which SAR instances will be started. Mask should contain at least two SAR instances for operation.</td></tr>
    <tr><td class="paramname">mode</td><td>specifies mode of SARs operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Simultaneously start continuous SAR0 and SAR1 scan */</span></div><div class="line">    <a class="code" href="group__group__sar__functions.html#ga939ae97436fb8ca44e6f61554d361101">Cy_SAR_SimultStart</a>(PASS, <a class="code" href="group__group__sysanalog__sar__select.html#gad932345b6de5ba9d894268a54ee6d035">CY_SAR_SAR0</a> | <a class="code" href="group__group__sysanalog__sar__select.html#ga94461e8af630635d798578036a947a91">CY_SAR_SAR1</a>, <a class="code" href="group__group__sar__enums.html#ggaf21d08e4f15f54ac638943e50538d95caf9d6d2d190b4a044611be54dbe147890">CY_SAR_START_CONVERT_CONTINUOUS</a>);</div><div class="line"></div><div class="line">    <span class="comment">/* Scenario: Stop SAR0 and SAR1 continuous scan */</span></div><div class="line">    <a class="code" href="group__group__sar__functions.html#ga8b1d25e53ea0afb54c136e03780f839b">Cy_SAR_SimultStop</a>(PASS, <a class="code" href="group__group__sysanalog__sar__select.html#gad932345b6de5ba9d894268a54ee6d035">CY_SAR_SAR0</a> | <a class="code" href="group__group__sysanalog__sar__select.html#ga94461e8af630635d798578036a947a91">CY_SAR_SAR1</a>);</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga8b1d25e53ea0afb54c136e03780f839b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b1d25e53ea0afb54c136e03780f839b">&#9670;&nbsp;</a></span>Cy_SAR_SimultStop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SAR_SimultStop </td>
          <td>(</td>
          <td class="paramtype">PASS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>sarMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops the selected SARs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>Pointer to structure describing PASS registers.</td></tr>
    <tr><td class="paramname">sarMask</td><td>specifies which SAR instances should be stopped.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Simultaneously start continuous SAR0 and SAR1 scan */</span></div><div class="line">    <a class="code" href="group__group__sar__functions.html#ga939ae97436fb8ca44e6f61554d361101">Cy_SAR_SimultStart</a>(PASS, <a class="code" href="group__group__sysanalog__sar__select.html#gad932345b6de5ba9d894268a54ee6d035">CY_SAR_SAR0</a> | <a class="code" href="group__group__sysanalog__sar__select.html#ga94461e8af630635d798578036a947a91">CY_SAR_SAR1</a>, <a class="code" href="group__group__sar__enums.html#ggaf21d08e4f15f54ac638943e50538d95caf9d6d2d190b4a044611be54dbe147890">CY_SAR_START_CONVERT_CONTINUOUS</a>);</div><div class="line"></div><div class="line">    <span class="comment">/* Scenario: Stop SAR0 and SAR1 continuous scan */</span></div><div class="line">    <a class="code" href="group__group__sar__functions.html#ga8b1d25e53ea0afb54c136e03780f839b">Cy_SAR_SimultStop</a>(PASS, <a class="code" href="group__group__sysanalog__sar__select.html#gad932345b6de5ba9d894268a54ee6d035">CY_SAR_SAR0</a> | <a class="code" href="group__group__sysanalog__sar__select.html#ga94461e8af630635d798578036a947a91">CY_SAR_SAR1</a>);</div></div><!-- fragment --></dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
